> For the complete documentation index, see [llms.txt](https://user.netmera.com/netmera-developer-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://user.netmera.com/netmera-developer-guide/api-documentation/recipes.md).

# Recipes

Recipes are hands-on walkthroughs that take a single business goal from start to finish. Unlike reference pages that describe the parameters of a service, a recipe covers the whole flow in order: preparation, the API requests, and verification. Every recipe follows the same structure: when to use it, prerequisites, numbered steps, and a verification checklist.

The recipes use the REST API. For authentication and request headers, see [Setup](/netmera-developer-guide/api-documentation/rest-api/setup.md), and for the error format, see [Error Responses](/netmera-developer-guide/api-documentation/rest-api/error-responses.md).

### Push Notifications

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-tags" style="color:$primary;">:tags:</i></h3></td><td><strong>Sending a Push Campaign to a Tagged Audience</strong></td><td>Tag users, send a push to the tag, and read the delivery statistics.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/sending-push-to-tagged-audience.md">Sending a Push Campaign to a Tagged Audience</a></td></tr><tr><td><h3><i class="fa-bullseye" style="color:$primary;">:bullseye:</i></h3></td><td><strong>Targeting a Push Campaign by Segment or Profile Attribute</strong></td><td>Send to segments or to users that match profile attributes, and schedule the send.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/targeting-by-segment-or-profile.md">Targeting a Push Campaign by Segment or Profile Attribute</a></td></tr><tr><td><h3><i class="fa-user-pen" style="color:$primary;">:user-pen:</i></h3></td><td><strong>Personalizing a Bulk Push with Profile Attributes</strong></td><td>Send one push in which every user sees values from their own profile.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/personalizing-bulk-push.md">Personalizing a Bulk Push with Profile Attributes</a></td></tr><tr><td><h3><i class="fa-language" style="color:$primary;">:language:</i></h3></td><td><strong>Sending a Multilingual Push</strong></td><td>Carry the title, text, and click action for several languages in one request.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/sending-multilingual-push.md">Sending a Multilingual Push</a></td></tr><tr><td><h3><i class="fa-image" style="color:$primary;">:image:</i></h3></td><td><strong>Sending a Push with Rich Media and Click Actions</strong></td><td>Add platform-specific media, choose the tap action, and pass custom parameters.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/rich-media-and-click-actions.md">Sending a Push with Rich Media and Click Actions</a></td></tr><tr><td><h3><i class="fa-hand-pointer" style="color:$primary;">:hand-pointer:</i></h3></td><td><strong>Capturing Preferences from Push Buttons</strong></td><td>Store the choice of a user in a profile attribute when a push button is tapped.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/capturing-preferences-from-push-buttons.md">Capturing Preferences from Push Buttons</a></td></tr><tr><td><h3><i class="fa-bell" style="color:$primary;">:bell:</i></h3></td><td><strong>Sending Transactional Push Notifications to a Single User</strong></td><td>Define a notification once, send it with per-user values, and check the result of a user.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/sending-transactional-push.md">Sending Transactional Push Notifications to a Single User</a></td></tr></tbody></table>

### Email

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-paper-plane" style="color:$primary;">:paper-plane:</i></h3></td><td><strong>Sending a Transactional Email to a Single User</strong></td><td>Add an address, send an email from a panel template, and attach files.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/sending-transactional-email.md">Sending a Transactional Email to a Single User</a></td></tr><tr><td><h3><i class="fa-envelope" style="color:$primary;">:envelope:</i></h3></td><td><strong>Sending Bulk Email with Dynamic HTML Content</strong></td><td>Send a different HTML body in every send using one empty email template and the sendBulkEmail service.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/sending-bulk-email-with-dynamic-html.md">Sending Bulk Email with Dynamic HTML Content</a></td></tr><tr><td><h3><i class="fa-table-list" style="color:$primary;">:table-list:</i></h3></td><td><strong>Sending Bulk Email with Template Parameters</strong></td><td>Fill the named placeholders of a panel email template with values from your own system at send time.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/sending-bulk-email-with-template-parameters.md">Sending Bulk Email with Template Parameters</a></td></tr></tbody></table>

### SMS

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-comment-sms" style="color:$primary;">:comment-sms:</i></h3></td><td><strong>Sending an SMS to a User</strong></td><td>Add phone numbers and send an SMS by notification key or by phone number.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/sending-sms.md">Sending an SMS to a User</a></td></tr></tbody></table>

### Events and Insights

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-bolt" style="color:$primary;">:bolt:</i></h3></td><td><strong>Tracking Custom Events</strong></td><td>Read the event schema and send a custom event for a user.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/tracking-custom-events.md">Tracking Custom Events</a></td></tr><tr><td><h3><i class="fa-heart" style="color:$primary;">:heart:</i></h3></td><td><strong>Showing Popularity Counts with the Favorite Count API</strong></td><td>Count the users that share a profile attribute value, for one value or many.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/showing-popularity-counts.md">Showing Popularity Counts with the Favorite Count API</a></td></tr><tr><td><h3><i class="fa-chart-line" style="color:$primary;">:chart-line:</i></h3></td><td><strong>Monitoring Delivery Results of Your Sends</strong></td><td>Read the statistics of a send or a time range, and the result of each user.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/monitoring-delivery-results.md">Monitoring Delivery Results of Your Sends</a></td></tr></tbody></table>

### Audiences and Devices

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-users" style="color:$primary;">:users:</i></h3></td><td><strong>Reading Segments and Segment Members</strong></td><td>List segments, read their members, and count push-permitted users.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/reading-segments-and-members.md">Reading Segments and Segment Members</a></td></tr><tr><td><h3><i class="fa-filter" style="color:$primary;">:filter:</i></h3></td><td><strong>Creating and Managing Segments</strong></td><td>Create, update, delete, and reopen a segment, follow its calculation, and send an email to it.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/creating-and-managing-segments.md">Creating and Managing Segments</a></td></tr><tr><td><h3><i class="fa-mobile-screen" style="color:$primary;">:mobile-screen:</i></h3></td><td><strong>Reading Devices and Device Tokens</strong></td><td>Read the devices of a user, list all tokens by page, and change the permission of a device.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/reading-devices-and-tokens.md">Reading Devices and Device Tokens</a></td></tr><tr><td><h3><i class="fa-vial" style="color:$primary;">:vial:</i></h3></td><td><strong>Preparing Test Devices</strong></td><td>Register the devices of reviewers so that they receive test messages from the panel.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/preparing-test-devices.md">Preparing Test Devices</a></td></tr></tbody></table>

### Users and Preferences

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-user-plus" style="color:$primary;">:user-plus:</i></h3></td><td><strong>Registering Users and Building a Profile</strong></td><td>Register users with tags and profile attributes, update the profile, and read it back.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/registering-users-and-profiles.md">Registering Users and Building a Profile</a></td></tr><tr><td><h3><i class="fa-sliders" style="color:$primary;">:sliders:</i></h3></td><td><strong>Managing Channel Permissions and Category Preferences</strong></td><td>Record consent from a preference center: channel opt-ins, category choices, and a read-back check.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/managing-channel-and-category-preferences.md">Managing Channel Permissions and Category Preferences</a></td></tr><tr><td><h3><i class="fa-user-xmark" style="color:$primary;">:user-xmark:</i></h3></td><td><strong>Handling User Deletion Requests</strong></td><td>Choose between standard and permanent deletion, and clear a single contact field.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/handling-user-deletion.md">Handling User Deletion Requests</a></td></tr></tbody></table>

### Inbox

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-inbox" style="color:$primary;">:inbox:</i></h3></td><td><strong>Building an In-App Notification Inbox</strong></td><td>Store pushes in an inbox, list them with read filters, and update their status.</td><td><a href="/netmera-developer-guide/api-documentation/recipes/building-in-app-notification-inbox.md">Building an In-App Notification Inbox</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://user.netmera.com/netmera-developer-guide/api-documentation/recipes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
